add page creation and update dates to footer #1736
Conversation
|
I was considering this repo: https://sphinx-git.readthedocs.io/en/latest/index.html However, it didn't seem to provide the information that I wanted. However, I don't know the sphinx ecosystem that well. Anyways, this is an implementation. |
|
Anything else needed here? |
|
@OriolAbril can you take a super fast look? |
There was a problem hiding this comment.
After a very quick look at the results mostly it doesn't seem to be working as intended.
See for example the preview of the "what is pytensor?" notebook:
It shows both creation and last update date as Oct 23. The notebook was definitely created before that, in fact the watermark a few lines above shows the last rerun date (which I know might not be the last update but might be even more relevant) to be Sep 13. Looking at the source it shows the first and last commit for this particular notebook is Sep 14.
If this works locally it might be an issue with how readthedocs clones the repo which is probably some kind of shallow clone. But given we already have two dates stored in each notebook, in the post directive and the watermark one maybe we could ensure (either with reviews or pre-commit or both) that the date in the post directive is the creation one and the one in the watermark reflects the last update. We can then highlight these two dates with the template being added in this PR
|
I am also now realizing the goal of the PR might be to add this for all documentation pages, not only for notebook in which case the workaround wouldn't work and we need to figure out how to get the git approach to work when building on readthedocs. |
3 participants
Description
This adds footer for dates: "Created: | Last updated: "
Is there an appetite for this?
Related Issue
Checklist
Type of change